/*******************************************************************************
 * Copyright 2016 Intuit
 * <p>
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************/
package com.intuit.wasabi.events;

import com.intuit.wasabi.analyticsobjects.Parameters;
import com.intuit.wasabi.experimentobjects.Experiment;

import javax.ws.rs.core.StreamingOutput;

/**
 * Exports events from a given Experiment.ID.
 */
public interface EventsExport {
    /**
     * Returns the streaming output for the given experiment ID and parameters
     *
     * @param experimentID Experiment ID
     * @param parameters   Parameters
     * @return StreamingOutput object
     */
    StreamingOutput getEventStream(Experiment.ID experimentID, Parameters parameters);
}
